Gold Medal Software 3

home *** CD-ROM | disk | FTP | other *** search

/ Gold Medal Software 3 / Gold Medal Software - Volume 3 (Gold Medal) (1994).iso / netutils / netelect.arj / READ.ME < prev

Wrap

Text File | 1994-02-04 | 25.7 KB | 580 lines

NetElect ---------- ON-LINE HELP FILE ----------------- Use arrow keys, page-up, page-down to view. Any key to exit. TOPICS: 1 - NEALARM.EXE 2 - NETELECT.EXE 2.1 - LOGINS: 2.1.1 - New Accounts: 2.1.2 - Existing Accounts: 2.3 - BASE SCREEN: 2.4 - SYSTEM MENU: 2.4.1 - Login 2.4.2 - Change password 2.4.3 - Configure 2.4.4 - Video 2.4.5 - Dos Shell 2.4.6 - Exit 2.5 - ISSUES MENU: 2.5.1 - All 2.5.2 - Current 2.5.3 - Open 2.5.4 - Closed 2.5.5 - Yours 2.5.6 - Referee 2.5.7 - Create 2.6 - ISSUE CREATION 2.6.1 - Edit screen 2.6.2 - Referee selection 2.6.3 - Selection size entry 2.6.4 - Invitations 2.7 - ISSUES DISPLAY 2.8 - REFEREE AN ISSUE 2.9 - VOTERS MENU 2.10 - HELP MENU NetElect is a database system that allows users of a network to vote on issues among themselves and to be notified when an issue is created or settled. Accounts are maintained for each user with a hierarchy of privilege and a modicum of security. Issues may be of binary type or of selection type, public or private. Multiple users can access the database simultaneously. NetElect is written in Borland C++ 3.1 using the TurboVision application framework. It runs under DOS, can use but does not require a mouse, can use but does not require a color monitor. NetElect is a shareware product and, as such, is provided at no charge to the user for evaluation. If you find this program useful and find that you are using NetElect after a 30 day trial period, you should make a registration payment of $20.00 to the author: Ron Mignery 85 Bartlett Street Somerville, MA 02145 The $20.00 registration fee will license one copy for use on any one network at any time. Registered users will receive updates of the program on request as they become available. What a deal! This is an intial release of the program and the author is still struggling with TurboVision so please excuse awkward phraseologies and interfaces. Any comments on the program would be more than welcome. A similar product, NetBet, exists to allow network users to place bets among themselves and to be notified when a bet is created or settled. A Windows version will follow someday. Two executables constitute the release: NETELECT.EXE and NEALARM.EXE These files must be in the execution path of all users. All users must further have read/write access to a common data subdirectory to which they log or to which they point with an environmental variable, NETELECT. Various data files will be created in this subdirectory as NetElect executes. A third file, READ.ME, (this file) should be placed in all NetElect data subdirectories. 1 - NEALARM.EXE------------------------------------------------------ NEALARM is intended to be executed in the login script of a network user. It scans a file of notices and signals the user when an issue creator has issued an invitation to that particular user or when that user has been assigned to settle an issue and the settlement date has arrived. It then removes that notice from the file so be aware that notices are only given once. The user's NetElect account # must be passed as a parameter to NEALARM.EXE. The user may also pass switches to suppress sound generation or to require a key press after each notification. Usage: NEALARM [-sw] <account #> Switches: -s No sound -w Wait for key press Usage example: ...inserted in login script... SHARE SET NETELECT=C:\NETELECT NEALARM -SW 13 ... Of course, NEALARM can also be executed outside a script at any time. When user 0 (the program manager) executes NEALARM, the notification file is packed to remove expired notices. 2 - NETELECT.EXE--------------------------------------------------------- Netelect.exe is executed by the user to place, review, create and referee issues. DOS share.exe should previously have been executed for networks that do not obviate its usage. Usage: [SHARE ] NETELECT It may be desirable to enter the program through a batch procedure that could execute share, set the NETELECT environmental variable, and execute netelect. Multiple NetElect systems could then be installed on a single network with multiple batch procedures (bat files), each specifying a different subdirectory through the the NETELECT variable for data files. 2.1 - LOGINS: Upon progam initiation, the user is requested to enter a name (not case sensitive). The user need enter no more characters than necessary to unambiguously identify an account. 2.1.1 - New Accounts: If no accounts have yet been created then the first name entered identifies the program manager account. Otherwise, if the name entered does not match the name for existing accounts, the user is either denied access or allowed to create an account depending on system configuration options available only to the program manager. If the user then chooses to create a new account, the program will ask for for a password (11 character maximum) for the account. 2.1.2 - Existing Accounts: If the name entered does match the name for existing account, the user will then be asked for the password for the account. 2.3 - BASE SCREEN: After the login, the user is presented with the base screen: ┌───────────┬──────────┬────────────┬─────────────────────────────┐ │System │Issues │Voters │Help │ ├───────────┴──────────┴────────────┴─────────────────────────────┤ │ Thurs Oct 12 10:12:03 │ │ │ │ ACCOUNT INFO for #1 John Q. Public SYSTEM INFO │ │ ---------------- ╔╗╔╦═╦═ ║ ----------- │ │ ║║║╠═╠══║╔═╦═╦═ # Voters :7 │ │ ║║║╩═╠══║╠═║ ║ # Categories :1 │ │ ║╚╝ ╚══╩╩═╩═║ # Issues :1 │ │ │ ├─────────────────────────────────────────────────────────────────┤ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ ├─────────────────────────────────────────────────────────────────┤ │ Alt-X exit │ └─────────────────────────────────────────────────────────────────┘ The top line is a menu bar from which menus may be activated by clicking with the mouse or by pressing the ALT key along with the highlighted letter of the desired menu. Or F10 may be pressed and the menu selected with the left-right arrow keys and activated by the ENTER key. The current user account number and name are displayed. This number is the one to be used with NEALARM as described above. On the right are displayed the total number of voters, number of categories of issues and the number of issues (outcomes) currently in the system. 2.4 - SYSTEM MENU: The SYSTEM menu presents the following selections: ┌───────────────────────────┐ │ Login │ │ Change password │ ├───────────────────────────┤ │ Configure │ │ Video │ │ Dos Shell │ │ Exit │ └───────────────────────────┘ In all menus, the mouse or an arrows key is used to selected the desired action and the mouse button or the ENTER key is then pressed. The ESC key aborts. 2.4.1 - Login - Presents the same dialog as for program initiation to enter the user into another account. 2.4.2 - Change password - Presents a same dialog for the user to change the password of the current account. 2.4.3 - Configure - Sets system options (only available to the program manager). Presents the following dialog: ┌──────────────────────────────────────────────────┐ │ │ │ Options: │ │ [ ] Disallow New Accounts │ │ [ ] Create Issue Privilege for New Accounts │ │ [ ] Create Category Privilege for New Accounts │ │ [ ] Referee Issue Privilege for New Accounts │ │ │ │ Starting money: $ 100.00 │ │ │ └──────────────────────────────────────────────────┘ In all dialog screens, the TAB key is used to move between fields. SHIFT-TAB moves backwards. When the options checkbox field is selected, arrows move among checkboxes and the SPACE BAR toggles the selections on and off. An X in the check box indicates that the option is active. ENTER accepts and closes the dialog. ESC aborts. 2.4.3.1 - Descriptions of Configure options: Disallow New Accounts - If login name not found, program exits rather than allow a new account to be created. Create Issue Privilege for New Accounts - Allows a new account user to create issues in the system. Create Category Privilege for New Accounts - Allows a new account user to create new categories of issues in the system. Referee Issue Privilege for New Accounts - Allows a new account user to settle issues in the system. 2.4.3.2 - Starting money - When the Starting money field is selected, the manager may then enter the initial amount of available money in new accounts. 2.4.4 - Video - Switches between 25 and 50 (or 43) line mode on VGA displays. 2.4.5 - Dos Shell - Exits program to a shell. Entering EXIT at the DOS prompt will return the user to the program. 2.4.6 - Exit - Exits program. Pressing Alt-X or clicking on Alt-X on the status line does the same. 2.5 - ISSUES MENU: The ISSUES menu presents the following selections: ┌───────────────────┐ │ All F2 │ │ Current F3 │ │ Open F4 │ │ Closed │ │ Settled │ │ Yours │ ├───────────────────┤ │ Referee F5 │ │ Create F6 │ └───────────────────┘ For any selection on this menu, the user must then select a category from a pick list of existing categories. For create an issue, the user also has the option of creating a new category on the list. Note that the user must have create category privilege to create a new category and create issue privilege to create an issue. 2.5.1 - All - Scans all issues in the selected category. F2 is a hot key for this selection. 2.5.2 - Current - Scans all issues in the selected category on which the user has cast votes or has been invited to vote. F3 is a hot key for this selection. 2.5.3 - Open - Scans all issues in the selected category on which votes may be cast (later than start date, earlier than close date). F4 is a hot key for this selection. 2.5.4 - Closed - Scans all issues in the selected category on which votes may not be cast (earlier than start date, later than close date). 2.5.5 - Settled - Scans all issues in the selected category that have been settled and not yet reused for new issues. 2.5.6 - Yours - Scans all issues in the selected category for which the user is the author. 2.5.7 - Referee - Scans all issues in the selected category for which the user has been designated as the referee. (The program manager can referee any issue regardless of the designated referee.) F5 is a hot key for this selection. 2.5.8 - Create - Allows the user to create a new issue in the selected category. (Requires create issue privilege.) F6 is a hot key for this selection. 2.6 - ISSUE CREATION 2.6.1 - Edit screen A issue is created in the following dialog: ╔═[■]══════════════════════════ Create an Issue ═════════════════════════╗ ║ Author: <account name> ║ ║ Category: <category> ║ ║ Outcome ║ ║ ┌────────────────────────────────────────────────────────────┐ ║ ║ │<enter a description of the issue as a possible outcome.> │ ║ ║ │ │ ║ ║ │ │ ║ ║ │ │ ║ ║ └────────────────────────────────────────────────────────────┘ ║ ║ Access Type ║ ║ [ ] Private (specify participants) ( ) Yes/No ║ ║ [ ] Secret (votes not displayed) () Selection ║ ║ ║ ║ YYYY/MM/DD-HH ║ ║ Start Date: 1994/02/04-12 ║ ║ End Date : 1995/02/04-12 ║ ║ Settlement: 1994/02/04-12 ║ ║ ║ ║ OK ▄ Cancel ║ ║ ▀▀▀▀▀▀ ▀▀▀▀▀▀ ║ ║ ║ ╚════════════════════════════════════════════════════════════════════════╝ The author enters a text description of the issue as a possible outcome to be voted on as true or false (or in the case of a selection issue, the author describes the range of possible selections and their numeric assignments). The author may mark the issue as private in which case it will be accessible only to those voters specified by the author (see invitations below) and the program manager. The author may mark the issue as secret in which case individual votes are not displayable for the issue. The author must select a type for the issue. For the selection type, multiple outcomes are allowed and should be enumerated in the issue description text. The author must enter an end date after which issues cannot be entered. The settlement date when the referee ajudicates the issue defaults to the end date but can be edited to a later date if desired. The start date when issues can first be entered defaults to the current date but again can be edited to a later date if desired. When ENTER or the OK button are pressed, the author is presented with further dialogs depending on the nature of the issue created: 2.6.2 - Referee selection First a pick list of voters is presented for selection of the referee. Note that a referee must have referee privilege to be eligible. The referee will ajudicate the issue when the settlement date arrives. The referee may also edit or cancel the issue at any time. An author can choose him or herself as referee if so privileged. 2.6.3 - Selection size entry If Selection type is selected then the following dialog is presented: ╔═[■]════════════════Selection Size ═══════════════════════╗ ║ How many outcomes are possible? (max 365) ║ ║ 1 ║ ║ ║ ║ How many votes per voter? ║ ║ 1 ║ ║ ║ ║ ║ ║ ║ ║ ║ ║ OK ▄ ║ ║ ▀▀▀▀▀▀ ║ ║ ║ ╚══════════════════════════════════════════════════════════╝ The author enters the number of outcomes and the number of votes per voter on this issue. 2.6.4 - Invitations Finally the author is presented with a list of all voters on the system from which voters can be selected. Any voters selected will be issued invitations for that issue and will have a slot reserved in the voters list. If the issue was marked private, only those invited may vote. Otherwise anybody may. 2.7 - ISSUES DISPLAY Simple Yes/no issues are displayed as follows: ╔═[■]═════════════════════════ Display an Issue ═════════════════════════════╗ ║ {Public,Private} <category> #n by <author> ║ ▓ ║ Votes may be cast from <start date> to <close date> ▓ ║ The issue will be settled on <settle date> by referee ▓ ║ Votes are to be cast in support of or against the following outcome: ▓ ║ ┌────────────────────────────────────────────────────────────┐ ▓ ║ │<outcome - a description of the issue as a possible outcome │ Tally ▄ ▓ ║ │ │ ▀▀▀▀▀▀▀ ▓ ║ │ │ ▓ ║ │ │ Next ▄ ▓ ║ └────────────────────────────────────────────────────────────┘ ▀▀▀▀▀▀▀ ▓ ║ ▓ ║ n ayes have have been cast, and n nays. ▓ ║ ▓ ║ You have voted {'Aye','Nay'}. Vote ▓ ║ () Skip ▓ ║ ( ) Yes ▓ ║ ( ) No ▓ ║ ( ) Cancel ▓ ║ ╚════════════════════════════════════════════════════════════════════════════╝ If the issue is open, the user may TAB to the Vote radio buttons to enter a vote for or against the outcome. The Tally button may be pressed to display a list of the voters and their votes on this issue. (Not available if the issue is marked secret and user is not program manager.) Selection issues are displayed as follows: ╔═[■]═════════════════════════ Display an Issue ═════════════════════════════╗ ║ {Public,Private} <category> #<n> by <author> ║ ▓ ║ Votes may be cast from <start date> to <close date> ▓ ║ The issue will be settled on <settle date> by referee ▓ ║ Votes are to be cast in support of one of the following outcomes: ▓ ║ ┌────────────────────────────────────────────────────────────┐ ▓ ║ │This is a Selection test │ Tally ▄ ▓ ║ │ │ ▀▀▀▀▀▀▀ ▓ ║ │ │ ▓ ║ │ │ Next ▄ ▓ ║ └────────────────────────────────────────────────────────────┘ ▀▀▀▀▀▀▀ ▓ ║ Each voter has n votes. There are nn possible outcomes. ▓ ║ You may select n outcomes. Choice #Votes ▓ ║ NO VOTE ▓ ║ n votes have been placed. 01 0 ▓ ║ You have n votes remaining. 02 0 ▓ ║ 03 0 ▓ ║ 04 0 ▓ ║ 05 0 ▓ ║ 06 0 ╚════════════════════════════════════════════════════════════════════════════╝ If the issue is open, the user may TAB to the Choice pick-list and select an outcome number from the list. 2.8 - REFEREE AN ISSUE A refereed issue is displayed with a radio button selection as follows: () Skip ( ) Yes ( ) No ( ) Cancel In all cases except skip, the issue is moved to the Settled list where it remains until a newly created issue overwrites it. The last 10 settled issues can be displayed. In the case of a selection issue, the referee is also presented with the outcome pick-list from which the winner is selected. An Edit button also appears to allow the referee to alter the issue. To settle a selection issue, the referee selects the winner from the pick- list and presses the Yes radio button. 2.9 - VOTERS MENU The Voters Menu has two selections: ┌───────────────────┐ │Display │ │Edit │ └───────────────────┘ Either presents a pick-list of all voters on the system. When a voter is selected, the following dialog appears: ╔═[■]═══{Display,Edit} Voter Info ═════════════════╗ ║ ║ ║ Name : <account name> ║ ║ ║ ║ Password : <password> ║ ║ ║ ║ Privilege: ║ ║ [X] Create Issues ║ ║ [X] Create Categories ║ ║ [X] Referee ║ ║ [X] Accounts Manager ║ ║ [X] Program Manager ║ ║ ║ ║ Cancel ▄ OK ▄ ║ ║ ▀▀▀▀▀▀▀▀ ▀▀▀▀▀▀▀▀ ║ ║ ║ ╚══════════════════════════════════════════════════╝ All values may be altered in the edit selection but edit is available only to accounts with Accounts Manager or Program Manager privilege. Passwords are only displayed to the Program Manager. 2.10 - HELP MENU The Help Menu has two selections: ┌───────────────────┐ │File F1 │ │About │ └───────────────────┘ File displays a window with this file in it. F1 is a hot key for this selection. About presents a window with the current version number of the program.